Skip to content

fix: hide sidebar on landing page and update config docs#47

Merged
rsbh merged 2 commits intomainfrom
fix_landing_page_sidebar
May 5, 2026
Merged

fix: hide sidebar on landing page and update config docs#47
rsbh merged 2 commits intomainfrom
fix_landing_page_sidebar

Conversation

@rsbh
Copy link
Copy Markdown
Member

@rsbh rsbh commented May 5, 2026

Summary

  • Hide sidebar on landing page for paper theme by passing hideSidebar={isLanding} to DocsLayout
  • Sync configuration.mdx with actual Zod schema: remove undocumented footer and llms sections, add missing description/icon fields for content and api entries

Test plan

  • Verified landing page renders without sidebar in versioned example
  • Verified docs pages still show sidebar

🤖 Generated with Claude Code

rsbh and others added 2 commits May 5, 2026 15:42
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Remove footer and llms sections that don't exist in schema.
Add missing description, icon fields for content and api entries.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented May 5, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
chronicle Ready Ready Preview, Comment May 5, 2026 10:20am

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 5, 2026

📝 Walkthrough

Summary by CodeRabbit

  • Documentation

    • Configuration guide updated to document new icon field support for API configurations and content cards, enabling enhanced visual customization. Example provided has been simplified.
  • UI Improvements

    • Landing page now displays with sidebar hidden for a cleaner, more focused presentation.

Walkthrough

This PR contains two independent changes: a configuration documentation update removing unused YAML sections and adding schema field references, plus a conditional sidebar visibility toggle in the app layout based on landing page detection.

Changes

Configuration Documentation

Layer / File(s) Summary
Example Cleanup
docs/content/docs/configuration.mdx
"Full example" YAML block removes unused footer and llms sections to simplify the sample configuration.
Schema References
docs/content/docs/configuration.mdx
content and api reference tables are extended with optional description and icon fields for metadata documentation.

Landing Page Sidebar Toggle

Layer / File(s) Summary
Layout Prop
packages/chronicle/src/server/App.tsx
DocsLayout conditionally receives hideSidebar={isLanding} to hide navigation when the resolved route is the landing page.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

  • raystack/chronicle#25: Modified the same configuration schema by introducing llms and content entries; this PR refines that documentation and removes llms from the example.
  • raystack/chronicle#20: Likely introduced the original configuration documentation with footer and llms examples that are now removed in this PR.

Suggested reviewers

  • rohilsurana
  • rohanchkrabrty
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes both main changes: hiding sidebar on landing page and updating configuration documentation.
Description check ✅ Passed The description is clearly related to the changeset, providing specific details about both the sidebar hiding feature and documentation updates.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix_landing_page_sidebar

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@rsbh rsbh requested a review from rohilsurana May 5, 2026 10:20
@rsbh rsbh merged commit aab68a1 into main May 5, 2026
3 of 4 checks passed
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/content/docs/configuration.mdx (1)

205-205: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

versions[].content type annotation is stale after adding description and icon.

Line 205 documents the content field as {dir, label}[], but it now accepts description and icon as well. Readers configuring version-scoped content won't know these fields are available there too.

📝 Proposed fix
-| `content` | `{dir, label}[]` | Content dirs for this version. Entries may rename, reorder, or omit top-level content dirs. |
+| `content` | `{dir, label, description?, icon?}[]` | Content dirs for this version. Entries may rename, reorder, or omit top-level content dirs. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/content/docs/configuration.mdx` at line 205, Update the docs entry for
versions[].content to reflect the new optional fields by changing the type
annotation from `{dir, label}[]` to `{dir, label, description?, icon?}[]` (or
similar notation showing description and icon are optional) wherever
`versions[].content` is documented; ensure the table row text and any
explanatory examples mention that `description` and `icon` are supported for
each content entry so readers know they can add those fields.
🧹 Nitpick comments (1)
docs/content/docs/configuration.mdx (1)

154-155: ⚡ Quick win

The content section YAML example and the icon description could be more helpful.

Two small gaps:

  1. The code example just above the table (lines 142–148) still only shows dir and label. Adding a third entry with description and icon would let readers copy-paste working config immediately.
  2. Both icon entries (here and line 315) say "Optional icon identifier" without specifying what format is accepted (e.g., Lucide icon name, a file path, a custom token). Even a brief parenthetical like (e.g., \BookOpen` from Lucide)` would save readers a trip to the source.
📝 Suggested example addition
 content:
   - dir: docs
     label: Docs
   - dir: dev
     label: Dev Docs
+  - dir: guides
+    label: Guides
+    description: Step-by-step guides for common workflows.
+    icon: BookOpen
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/content/docs/configuration.mdx` around lines 154 - 155, Add a third
example entry in the "content" section YAML showing `description` and `icon`
alongside `dir` and `label` so users can copy a complete example (referencing
the `content` example block and the `description`/`icon` fields). Update the
`icon` table description text to specify the accepted format (e.g., a Lucide
icon name like `BookOpen`, a relative file path, or a custom token) in
parentheses so readers know which kinds of values `icon` accepts wherever `icon`
is documented.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In `@docs/content/docs/configuration.mdx`:
- Line 205: Update the docs entry for versions[].content to reflect the new
optional fields by changing the type annotation from `{dir, label}[]` to `{dir,
label, description?, icon?}[]` (or similar notation showing description and icon
are optional) wherever `versions[].content` is documented; ensure the table row
text and any explanatory examples mention that `description` and `icon` are
supported for each content entry so readers know they can add those fields.

---

Nitpick comments:
In `@docs/content/docs/configuration.mdx`:
- Around line 154-155: Add a third example entry in the "content" section YAML
showing `description` and `icon` alongside `dir` and `label` so users can copy a
complete example (referencing the `content` example block and the
`description`/`icon` fields). Update the `icon` table description text to
specify the accepted format (e.g., a Lucide icon name like `BookOpen`, a
relative file path, or a custom token) in parentheses so readers know which
kinds of values `icon` accepts wherever `icon` is documented.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: c83db771-e239-452f-9a32-7fe97286507e

📥 Commits

Reviewing files that changed from the base of the PR and between a8048f4 and f72c135.

📒 Files selected for processing (2)
  • docs/content/docs/configuration.mdx
  • packages/chronicle/src/server/App.tsx

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants